============Options Location============

1. Go your ACP options
2. Click on "sonnb - Stop Spam Here"

============First galance============

We have 7 main parts of configuration:
1. Bot Options on Registration
2. Point Options on Registration (Risk Indicator)
3. Akismet Option on Posting
4. Keyword Options on Posting
5. Link Options on Posting
6. Sender/Receiver Options for create Report/Personal Conversation on Spam action
7. Extra Options
8. User Permission to Mark Post As Spam/Delete Post As Spam and Who could bypass Link/Keyword/Akismet check. (This is located in User Group Permission).

============Detail configuration============

******************************************************************
1. Bot Options on Registration (Tab: "[Registration] Bot Options")
******************************************************************
a. What is this
	- This section show you options to perform on during user registration process. 
	This would call for integrated bot checking API addon, such as: Stop Forum Spam,
	SpamBusted... that was mentioned earlier in INSTALL.txt
b. Configuration
	- Check on "Enable Registration Check" to enable checking on user registration
	- Check "Username"/"Email"/"IP Address" to check on, depend on your requirement
	- Select an action that would be called once spammer/bot was found in "Action On Found"
	dropdown list.
	- "Add a hidden field to registration page" option being used to check Auto Register Bot.
	This bot would try to fill all the fields in your registration form including hidden fields 
	that would not visible to normal users. By enable this option, we can know whenever user is a bot.
		Note: You must configure hidden field hook if you do not have TMS installed as mentioned in INSTALL.txt
	- "Mark As Bot If Form Submitting Time Less Than": Configure this option to detect Auto Register Bot.
	These kind of bot might fill the form very fast that normal user mostly unable to do.
	Input 0 if you want to disable this function.

******************************************************************	
2. Point Options on Registration (Risk Indicator) (Tab: [Registration] Point Options)
******************************************************************
a. What is this
	- This is a kind of Risk Indicator, that would check for configured settings to detect spammer.
	Such as: you could give more points for user that using yahoo and come from Russia. If any user
	that using yahoo and come from Russia would reach a specified point and would be process with configured action
b. Configuration
	- Enable "Enable Point Checking System (During Registration)" to active this feature.
	- "IP to Point" field: inside this field, you could enter the list of IPs together with points that you would give
	to these IP. For example:
		41.72.96.0/19=>20
		This mean users come from IP range 41.72.96.0/19 would be marked for 20 points
	- "Email Domain To Point" The same with "IP to Point" field. For example:
		yahoo.com=>20
		This mean users that using yahoo domain for their email would be marked for 20 points.
	- "Username Regex To Point". For example:
		angrybird=>20 
		Give 20 Points to users who trying to register using username contains "angrybird", 
		ie: angrybirdUser, angrybirdbaby, ladyangrybird 
	- "Point To Process" the indicator that we would check for these users if marked point reach specify point
	- "Action To Process" Which actions would be performed if users reach specified point.
	
******************************************************************
3. Akismet Option on Posting (Tab: [Posting] Akismet Options)
******************************************************************
a. What is this
	- Akismet is a popular content spamming collection datbase. Almost spamming contents
	in the internet are recorded in Akismet database. We would run Akismet checking during user posting
	process to ensure that they are not posting spamming messages.
b. Configuration
	- "Enable User Post Check based on Akismet" to active this feature
	- "Akismet API (required)" This is required, you have to obtain an API key in order to use this feature
	Get an API key for you from: http://www.akismet.com/
	- "Check On": Check on item that you want this feature to check on user posting. 
		+  New Thread: Check when user submit new thread
		+  New Reply: Check when user submit a new post to a thread
		+  New Converstation: Check when user start a new conversation
		+  Reply to an Converstation: Check when user reply to a conversation
		+  New Profile Post: Check when user post a new Profile Post (User Profile Page)
		+  Comment to a Profile Post: Check when user comment to a Profile Post (User Profile Page)
		+  About Me: Check when user edit/save About Me page (User's Account Information)
		+  User Signature: Check when user edit/save signatrue
	- "Disable checking if user's post count above": Disable this checking if user has more than X posts
	- "Disable checking if user joined for x days": Disable this checking if user has joined more than X days
	- "Applicable Forums": This option apply to :New Thread/New Reply. If you want to perform check on
	specified forums only then you could select them here.
	- "Action On Found": Action would be performed once user's content is found in Akismet Database.

******************************************************************
4. Keyword Options on Posting (Tab: [Posting] Keyword Options
******************************************************************
a. What is this
	- You might want to block some bad/probihited words from user's post. XF does have default censor option
	but it only replace bad words with mask characters (or as you have defined), this feature could give you more
	options to control the action. You could moderate, block... the messages that contains specified words rather 
	than hide them.
b. Configuration
	- "Enable Keywords Checking" to active this feature
	- "Keyword List" List of keywords that you want to filter. You could specify keyword and action that would be
	performed to that keyword. Example:
		fuk=>block
		Once this keyword was found in the message, the message would be blocked without process any remain words
	You also just input the keywords without action and separated by new lines. Example:
		fuk
		sht
		
	- "Check On" Check on item that you want this feature to check on user posting. 
		+  New Thread: Check when user submit new thread
		+  New Reply: Check when user submit a new post to a thread
		+  New Converstation: Check when user start a new conversation
		+  Reply to an Converstation: Check when user reply to a conversation
		+  New Profile Post: Check when user post a new Profile Post (User Profile Page)
		+  Comment to a Profile Post: Check when user comment to a Profile Post (User Profile Page)
		+  About Me: Check when user edit/save About Me page (User's Account Information)
		+  User Signature: Check when user edit/save signatrue
	- "Disable checking if user's post count above": Disable this checking if user has more than X posts
	- "Disable checking if user joined for x days": Disable this checking if user has joined more than X days
	- "Applicable Forums": This option apply to :New Thread/New Reply. If you want to perform check on
	specified forums only then you could select them here.
	- "Action On Found": If you do not define action for each keyword. You could choose action here, it would
	apply to all keywords that do not have action defined.

******************************************************************
5. Link Options on Posting (Tab: [Posting] Link Options
******************************************************************
a. What is this
	- On some boards or specified forums, you might want to check/block user to post links inside their messages

b. Configuration
	- "Enable Check Link"  to active this feature
	- "Check On" Check on item that you want this feature to check on user posting. 
		+  New Thread: Check when user submit new thread
		+  New Reply: Check when user submit a new post to a thread
		+  New Converstation: Check when user start a new conversation
		+  Reply to an Converstation: Check when user reply to a conversation
		+  New Profile Post: Check when user post a new Profile Post (User Profile Page)
		+  Comment to a Profile Post: Check when user comment to a Profile Post (User Profile Page)
		+  About Me: Check when user edit/save About Me page (User's Account Information)
		+  User Signature: Check when user edit/save signatrue
	- "Disable checking if user's post count above": Disable this checking if user has more than X posts
	- "Disable checking if user joined for x days": Disable this checking if user has joined more than X days
	- "Applicable Forums": This option apply to :New Thread/New Reply. If you want to perform check on
	specified forums only then you could select them here.
	- "Action On Found": Action would be performed once links was found in user's messages

******************************************************************
6. Sender/Receiver Options for create Report/Personal Conversation on Spam action (Tab: [Report] Sender/Receivers Options)
******************************************************************
a. What is this
	- This tab is used to configure extra options for other actions that is used in other tabs

b. Configuration
	- "PC Sender": This is userid of user that would be used to Make a conversation if you are using action
	"Allow to post and send a warning PC to specified Mods" somewhere in Akismet/Link/Keyword tab
	- "PC Receipt": This is a list of conversation recipient (separated by commas) if you are using action
	"Allow to post and send a warning PC to specified Mods" somewhere in Akismet/Link/Keyword tab
	- "Report User ID": This is userid of user that would be used to Make a report if you are using action
	"Allow to post and make a report in Report System" somewhere in Akismet/Link/Keyword tab

******************************************************************
7. Extra Options (Tab: [Extra] Advanced Options)
******************************************************************
a. What is this
	- This section contains some extra settings for the addon
b. Configuration:
	- "Maximum Log Life Time": Automatically remove old logs after x days (via Cron Task).
	
******************************************************************
8. User Permission to Mark Post As Spam/Delete Post As Spam.
******************************************************************
a. What is this
	- This section contains 2 permission
		+ "Delete Post As Spam": WARNING: This is very powerful permission, you should only set this to your administrators
		With this  permission, user could delete/ban/discourage users or delete all user's Threads/Posts/Profile Posts.
		+ "Mark Post As Spam": This permission allows user to mark a Post/Profile Post as spam, marked Post/Profile Post 
		would be sent to moderation queue to be reviewed by Forum's Staffs. Enable for usergoup that would help you to 
		improve forum content with spam-free.
b. Go to Permission Section
	- From AdminCP, Click on "Users" Tab, Look for "Permission" tab in the left panel. Go to "Usergroup Permission/User Permission"
	as you like. Croll down and locate for "sonnb - Stop Spam Here" permission group.
	
c. Configuration
	- From "sonnb - Stop Spam Here" permission group, enable these two permission to your desired User Group/User.